<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>PlPN::SearchOptions - The search options object</title>
<link rel="stylesheet" href="../PlPN.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body>


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#methods">METHODS</a></li>
	<li><a href="#copyright_and_licence">COPYRIGHT and LICENCE</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>PlPN::SearchOptions - The search options object</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
        use PlPN qw(PN :EFIFFileSet :EFindWhere);
        
        my $uso = PN-&gt;GetUserSearchOptions;
        $uso-&gt;UseRegExp(1);
        $uso-&gt;FindText($pattern);
        PN-&gt;FindInFiles($uso);
        
        # etc.</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>Allows setting of search options from Perl.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<dl>
<dt><strong><a name="findtext" class="item">FindText([$text])</a></strong></dt>

<dd>
<p>Gets or sets the text to be found.</p>
</dd>
<dt><strong><a name="matchwholeword" class="item">MatchWholeWord([1|0])</a></strong></dt>

<dt><strong><a name="matchcase" class="item">MatchCase([1|0])</a></strong></dt>

<dt><strong><a name="useregexp" class="item">UseRegExp([1|0])</a></strong></dt>

<dt><strong><a name="searchbackwards" class="item">SearchBackwards([1|0])</a></strong></dt>

<dt><strong><a name="loopok" class="item">LoopOK([1|0])</a></strong></dt>

<dt><strong><a name="useslashes" class="item">UseSlashes([1|0])</a></strong></dt>

<dt><strong><a name="nocursormove" class="item">NoCursorMove([1|0])</a></strong></dt>

<dt><strong><a name="replaceinselection" class="item">ReplaceInSelection([1|0])</a></strong></dt>

<dt><strong><a name="recurse" class="item">Recurse([1|0])</a></strong></dt>

<dt><strong><a name="includehidden" class="item">IncludeHidden([1|0])</a></strong></dt>

<dt><strong>Recurse([1|0])</strong></dt>

<dt><strong><a name="found" class="item">Found([1|0])</a></strong></dt>

<dd>
<p>Gets or sets the associated boolean option.</p>
<p><code>Found</code> is an indicator of whether the search was successful. It will be
set automatically by the system, but you can, for example, reset it to a
false value and perform the search again.</p>
</dd>
<dt><strong><a name="findtarget" class="item">FindTarget([$target])</a></strong></dt>

<dd>
<p>Gets or sets the search target. The target constants are exposed via the
<code>:EFindWhere</code> tag in <a href="../PlPN.html">PlPN</a>. These constants are:</p>
<dl>
<dt><strong><a name="elwcurrentdoc" class="item">elwCurrentDoc</a></strong></dt>

<dt><strong><a name="elwalldocs" class="item">elwAllDocs</a></strong></dt>

<dt><strong><a name="elwcurrentproj" class="item">elwCurrentProj</a></strong></dt>

<dt><strong><a name="elwselection" class="item">elwSelection</a></strong></dt>

</dl>
</dd>
<dt><strong><a name="replacetext" class="item">ReplaceText([$text])</a></strong></dt>

<dd>
<p>Gets or sets the replacement text.</p>
</dd>
<dt><strong><a name="fileexts" class="item">FileExts([$extensions])</a></strong></dt>

<dd>
<p>Gets or sets the list of file extension filters. <code>$extensions</code> is a
semi-colon separated list of file extensions:</p>
<pre>
        $uso-&gt;FileExts(&quot;*.pl;*.pm;*.pod&quot;);</pre>
<p>DETERMINE FORMAT.</p>
</dd>
<dt><strong><a name="searchpath" class="item">SearchPath([$path])</a></strong></dt>

<dd>
<p>Gets or sets the search path.</p>
</dd>
<dt><strong><a name="fileset" class="item">FileSet([$fileSet])</a></strong></dt>

<dd>
<p>Gets or sets the file set to search in. The file set constants are exposed
via the <code>:EFIFFileSet</code> tag in <a href="../PlPN.html">PlPN</a>. These constants are:</p>
<dl>
<dt><strong><a name="ifpath" class="item">ifPath</a></strong></dt>

<dt><strong><a name="fifsinglefile" class="item">fifSingleFile</a></strong></dt>

<dt><strong><a name="fifopenfiles" class="item">fifOpenFiles</a></strong></dt>

<dt><strong><a name="fifactiveprojectfiles" class="item">fifActiveProjectFiles</a></strong></dt>

</dl>
<p><code>$fileSet</code> defaults to <code>fifPath</code>.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="copyright_and_licence">COPYRIGHT and LICENCE</a></h1>
<p>Copyright (c) 2012 Sean Healy. All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.</p>

</body>

</html>
